home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / scale.n < prev    next >
Text File  |  1995-07-25  |  16KB  |  330 lines
  1.  
  2.  
  3.  
  4.      ssssccccaaaalllleeee((((nnnn))))                     TTTTkkkk (((( ))))                      ssssccccaaaalllleeee((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           scale - Create and manipulate scale widgets
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           ssssccccaaaalllleeee _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16.      SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
  17.           aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd               bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh     ffffoooonnnnttttoooorrrriiiieeeennnntttt     |
  18.           bbbbaaaacccckkkkggggrrrroooouuuunnnndddd      ccccuuuurrrrssssoooorrrr         ffffoooorrrreeeeggggrrrroooouuuunnnndddd      rrrreeeelllliiiieeeeffff         |
  19.  
  20.           See the ``options'' manual entry for details on the standard
  21.           options.
  22.  
  23.      WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
  24.           Name:           ccccoooommmmmmmmaaaannnndddd
  25.           Class:          CCCCoooommmmmmmmaaaannnndddd
  26.           Command-Line Switch:----ccccoooommmmmmmmaaaannnndddd
  27.  
  28.                Specifies  the  prefix  of  a  Tcl  command  to  invoke
  29.                whenever   the   value   of   the   scale   is  changed
  30.                interactively.  The actual  command  consists  of  this
  31.                option  followed  by  a space and a number.  The number
  32.                indicates the new value of the scale.
  33.  
  34.           Name:           ffffrrrroooommmm
  35.           Class:          FFFFrrrroooommmm
  36.           Command-Line Switch:----ffffrrrroooommmm
  37.  
  38.                Specifies the value corresponding to the  left  or  top
  39.                end of the scale.  Must be an integer.
  40.  
  41.           Name:           llllaaaabbbbeeeellll
  42.           Class:          LLLLaaaabbbbeeeellll
  43.           Command-Line Switch:----llllaaaabbbbeeeellll
  44.  
  45.                Specifies a string to displayed  as  a  label  for  the
  46.                scale.  For vertical scales the label is displayed just
  47.                to the  right  of  the  top  end  of  the  scale.   For
  48.                horizontal scales the label is displayed just above the
  49.                left end of the scale.
  50.  
  51.           Name:           lllleeeennnnggggtttthhhh
  52.           Class:          LLLLeeeennnnggggtttthhhh
  53.           Command-Line Switch:----lllleeeennnnggggtttthhhh
  54.  
  55.                Specifies the desired long dimension of  the  scale  in  |
  56.                screen  units  (i.e.  any  of  the  forms acceptable to  |
  57.                TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss).  For vertical scales this is the scale's
  58.                height;  for horizontal scales it is the scale's width.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/23/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      ssssccccaaaalllleeee((((nnnn))))                     TTTTkkkk (((( ))))                      ssssccccaaaalllleeee((((nnnn))))
  71.  
  72.  
  73.  
  74.           Name:           sssshhhhoooowwwwVVVVaaaalllluuuueeee
  75.           Class:          SSSShhhhoooowwwwVVVVaaaalllluuuueeee
  76.           Command-Line Switch:----sssshhhhoooowwwwvvvvaaaalllluuuueeee
  77.  
  78.                Specifies a boolean value indicating whether or not the
  79.                current value of the scale is to be displayed.
  80.  
  81.           Name:           sssslllliiiiddddeeeerrrrFFFFoooorrrreeeeggggrrrroooouuuunnnndddd
  82.           Class:          sssslllliiiiddddeeeerrrrFFFFoooorrrreeeeggggrrrroooouuuunnnndddd
  83.           Command-Line Switch:----sssslllliiiiddddeeeerrrrffffoooorrrreeeeggggrrrroooouuuunnnndddd
  84.  
  85.                Specifies the color to use for drawing the slider under
  86.                normal  conditions.   When  the  mouse is in the slider
  87.                window then the slider's color  is  determined  by  the
  88.                aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd option.
  89.  
  90.           Name:           sssslllliiiiddddeeeerrrrLLLLeeeennnnggggtttthhhh
  91.           Class:          SSSSlllliiiiddddeeeerrrrLLLLeeeennnnggggtttthhhh
  92.           Command-Line Switch:----sssslllliiiiddddeeeerrrrlllleeeennnnggggtttthhhh
  93.  
  94.                Specfies the size of the  slider,  measured  in  screen  |
  95.                units along the slider's long dimension.  The value may  |
  96.                be  specified  in  any  of  the  forms  acceptable   to  |
  97.                TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.                                            |
  98.  
  99.           Name:           ssssttttaaaatttteeee                                         |
  100.           Class:          SSSSttttaaaatttteeee                                         |
  101.           Command-Line Switch:----ssssttttaaaatttteeee                                    |
  102.  
  103.                                                                              ||
  104.                Specifies  one  of two states for the scale:  nnnnoooorrrrmmmmaaaallll or  |
  105.                ddddiiiissssaaaabbbblllleeeedddd.  If the scale is disabled then the value  may  |
  106.                not  be  changed  and the scale won't activate when the  |
  107.                mouse enters it.
  108.  
  109.           Name:           ttttiiiicccckkkkIIIInnnntttteeeerrrrvvvvaaaallll
  110.           Class:          TTTTiiiicccckkkkIIIInnnntttteeeerrrrvvvvaaaallll
  111.           Command-Line Switch:----ttttiiiicccckkkkiiiinnnntttteeeerrrrvvvvaaaallll
  112.  
  113.                Must be  an  integer  value.   Determines  the  spacing
  114.                between  numerical tick-marks displayed below or to the
  115.                left of the slider.  If specified as 0, then  no  tick-
  116.                marks will be displayed.
  117.  
  118.           Name:           ttttoooo
  119.           Class:          TTTToooo
  120.           Command-Line Switch:----ttttoooo
  121.  
  122.                Specifies the  value  corresponding  to  the  right  or
  123.                bottom  end  of  the  scale.  Must be an integer.  This
  124.                value may be either less than or greater than the  ffffrrrroooommmm
  125.                option.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/23/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      ssssccccaaaalllleeee((((nnnn))))                     TTTTkkkk (((( ))))                      ssssccccaaaalllleeee((((nnnn))))
  137.  
  138.  
  139.  
  140.           Name:           wwwwiiiiddddtttthhhh
  141.           Class:          WWWWiiiiddddtttthhhh
  142.           Command-Line Switch:----wwwwiiiiddddtttthhhh
  143.  
  144.                Specifies the desired narrow dimension of the scale  in  |
  145.                screen  units  (i.e.  any  of  the  forms acceptable to  |
  146.                TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss).  For vertical scales this is the scale's
  147.                width;   for  horizontal  scales  this  is  the scale's
  148.                height.
  149.      _________________________________________________________________
  150.  
  151.  
  152.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  153.           The ssssccccaaaalllleeee  command  creates  a  new  window  (given  by  the
  154.           _p_a_t_h_N_a_m_e  argument)  and  makes  it  into  a  scale  widget.
  155.           Additional options, described above, may be specified on the
  156.           command  line or in the option database to configure aspects
  157.           of the scale such as its colors,  orientation,  and  relief.
  158.           The  ssssccccaaaalllleeee  command  returns  its _p_a_t_h_N_a_m_e argument.  At the
  159.           time this command is invoked, there must not exist a  window
  160.           named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  161.  
  162.           A scale is a widget that displays a rectangular region and a
  163.           small _s_l_i_d_e_r.  The rectangular region corresponds to a range
  164.           of integer values (determined by the ffffrrrroooommmm and  ttttoooo  options),
  165.           and  the position of the slider selects a particular integer
  166.           value.  The slider's position (and hence the scale's  value)
  167.           may  be  adjusted  by clicking or dragging with the mouse as
  168.           described in  the  BINDINGS  section  below.   Whenever  the
  169.           scale's  value  is  changed, a Tcl command is invoked (using
  170.           the ccccoooommmmmmmmaaaannnndddd option) to notify other  interested  widgets  of
  171.           the change.
  172.  
  173.           Three annotations may be displayed in  a  scale  widget:   a
  174.           label appearing at the top-left of the widget (top-right for
  175.           vertical scales), a number  displayed  just  underneath  the
  176.           slider (just to the left of the slider for vertical scales),
  177.           and a collection of numerical tick-marks just underneath the
  178.           current  value  (just  to  the left of the current value for
  179.           vertical scales).  Each of these three  annotations  may  be
  180.           selectively  enabled  or  disabled  using  the configuration
  181.           options.
  182.  
  183.  
  184.      WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
  185.           The ssssccccaaaalllleeee command creates a new Tcl command  whose  name  is
  186.           _p_a_t_h_N_a_m_e.   This  command  may  be  used  to  invoke various
  187.           operations on the widget.   It  has  the  following  general
  188.           form:
  189.  
  190.                _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  191.           _O_p_t_i_o_n and the _a_r_gs determine  the  exact  behavior  of  the
  192.  
  193.  
  194.      Page 3                                          (printed 7/23/95)
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.      ssssccccaaaalllleeee((((nnnn))))                     TTTTkkkk (((( ))))                      ssssccccaaaalllleeee((((nnnn))))
  202.  
  203.  
  204.  
  205.           command.   The  following  commands  are  possible for scale
  206.           widgets:
  207.  
  208.           _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  209.                Query  or  modify  the  configuration  options  of  the
  210.                widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  211.                describing all of the available  options  for  _p_a_t_h_N_a_m_e
  212.                (see  TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of
  213.                this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  214.                the  command  returns  a  list describing the one named
  215.                option  (this   list   will   be   identical   to   the
  216.                corresponding  sublist  of  the  value  returned  if no
  217.                _o_p_t_i_o_n is specified).   If  one  or  more  _o_p_t_i_o_n-_v_a_l_u_e
  218.                pairs  are  specified,  then  the  command modifies the
  219.                given widget option(s) to have the given value(s);   in
  220.                this  case the command returns an empty string.  _O_p_t_i_o_n
  221.                may have any  of  the  values  accepted  by  the  ssssccccaaaalllleeee
  222.                command.
  223.  
  224.           _p_a_t_h_N_a_m_e ggggeeeetttt
  225.                Returns a decimal string giving the  current  value  of
  226.                the scale.
  227.  
  228.           _p_a_t_h_N_a_m_e sssseeeetttt _v_a_l_u_e
  229.                This command is invoked to change the current value  of
  230.                the  scale,  and hence the position at which the slider
  231.                is displayed.  _V_a_l_u_e gives the new value for the scale.
  232.  
  233.  
  234.      BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  235.           When a new scale is  created,  it  is  given  the  following
  236.           initial behavior by default:
  237.  
  238.           <<<<EEEEnnnntttteeeerrrr>>>>             Change  the  slider   display   to   use
  239.                               aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd        instead       of
  240.                               sssslllliiiiddddeeeerrrrFFFFoooorrrreeeeggggrrrroooouuuunnnndddd.
  241.  
  242.           <<<<LLLLeeeeaaaavvvveeee>>>>             Reset  the   slider   display   to   use
  243.                               sssslllliiiiddddeeeerrrrFFFFoooorrrreeeeggggrrrroooouuuunnnndddd        instead       of
  244.                               aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd.
  245.  
  246.           <<<<BBBBuuuuttttttttoooonnnnPPPPrrrreeeessssssss----1111>>>>     Change the slider display  so  that  the
  247.                               slider   appears   sunken   rather  than
  248.                               raised.  Move the slider (and adjust the
  249.                               scale's  value)  to  correspond  to  the
  250.                               current mouse position.
  251.  
  252.           <<<<BBBBuuuuttttttttoooonnnn1111----MMMMoooottttiiiioooonnnn>>>>    Move the slider (and adjust the  scale's
  253.                               value)  to  correspond  to  the  current
  254.                               mouse position.
  255.  
  256.           <<<<BBBBuuuuttttttttoooonnnnRRRReeeelllleeeeaaaasssseeee----1111>>>>   Reset the slider  display  so  that  the
  257.  
  258.  
  259.  
  260.      Page 4                                          (printed 7/23/95)
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.      ssssccccaaaalllleeee((((nnnn))))                     TTTTkkkk (((( ))))                      ssssccccaaaalllleeee((((nnnn))))
  268.  
  269.  
  270.  
  271.                               slider appears raised again.
  272.  
  273.  
  274.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  275.           scale, widget
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.      Page 5                                          (printed 7/23/95)
  327.  
  328.  
  329.  
  330.